package com.example.project.projectspringcloud.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * 在线Api文档
 */
@Configuration
public class SwaggerConfig {

    @Value("${swagger-enable}")
    private boolean swaggerEnable;

    @Value("${base-package}")
    private String basePackage;

    /**
     * 调用apiInfo方法, 创建一个ApiInfo实例, 里面是展示在文档页面信息内容
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).enable(swaggerEnable).apiInfo(apiInfo())
                .select()
                // 控制暴露出去的路径下的实例, 如果某个接口不想暴露,可以使用以下注解, @ApiIgnore 这样,该接口就不会暴露在 swagger2 的页面下
                .apis(RequestHandlerSelectors.basePackage(basePackage)).paths(PathSelectors.any()).build();
    }

    /**
     * 构建api文档的描述
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 页面标题
                .title("project文档")
                // 创建人
                .contact(new Contact("Christopher Jones", null, "Seng_chen@163.com"))
                // 版本号
                .version("1.0")
                // 描述
                .description("Web Application API").build();
    }
}
